SetControlProperty

SetControlProperty
Header:	Controls.h		Carbon status:	Supported

Associates data with a control.

OSStatus SetControlProperty (
    ControlRef control, 
    OSType propertyCreator, 
    OSType propertyTag, 
    UInt32 propertySize, 
    void *propertyData
);

control: A handle to the control with which you wish to associate data.
propertyCreator: Your program’s signature, as registered through Apple Developer Technical Support. If your program is of a type that would not normally have a signature (for example, a plug-in), you should still register and use a signature in this case, even though your program’s file may not have the same creator code as the signature that you register. The 'macs' property signature is reserved for the system and should not be used.
propertyTag: A value identifying the data. You define the tag your application uses to identify the data.
propertySize: A value specifying the size of the data.
propertyData: On input, a pointer to data of any type. Pass a pointer to a buffer containing the data to be associated; this buffer should be at least as large as the value specified in the propertySize parameter.

function result: A result code.

DISCUSSION

Your application may use the SetControlProperty function to associate any type of data with a control.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.5 and later when Carbon 1.0.2 or later is present.